Resource events

Keycloak REST Services 1.3.1.Final

Path: / admin / realms / {realm} / events

Query events. Returns all events, or will query based on URL query parameters listed here

Path parameters:

realm - realm name (not id!)

Sub-Resources

Resources
Name	Description
config	View the events provider and how it is configured.

Resource Methods

Method Summary
Name	Description
`GET /admin/realms/{realm}/events?client=…&user=…&dateFrom=…&dateTo=…&ipAddress=…&first=…&max=…`	Query events.
`DELETE /admin/realms/{realm}/events`	Delete all events.

Query events. Returns all events, or will query based on URL query parameters listed here

HTTP Example:: GET /admin/realms/{realm}/events?client=…&user=…&dateFrom=…&dateTo=…&ipAddress=…&first=…&max=…
API Example:: RealmAdminResource.getEvents({'client': /* client app or oauth client name */, 'user': /* user user id */, 'dateFrom': /* dateFrom */, 'dateTo': /* dateTo */, 'ipAddress': /* ipAddress */, 'first': /* firstResult */, 'max': /* maxResults */, 'realm': /* name realm name (not id!) */});
Output:: List<Event> -
Query parameters:: client - app or oauth client name; user - user id; dateFrom; dateTo; ipAddress; first; max
Produces:: application/json

Delete all events.

HTTP Example:: DELETE /admin/realms/{realm}/events
API Example:: RealmAdminResource.clearEvents({'realm': /* name realm name (not id!) */});
Output:: void

Keycloak REST Services 1.3.1.Final